home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 23 / Amiga Format AFCD23 (Feb 1998, Issue 107).iso / -seriously_amiga- / shareware / programming / mui / mcc_date / developer / autodocs / mcc_date.doc
Text File  |  1997-12-06  |  21KB  |  879 lines
  1. TABLE OF CONTENTS
  2.  
  3. Date/--background--
  4. Date/MUIA_Date_Country
  5. Date/MUIA_Date_Day
  6. Date/MUIA_Date_FirstWeekday
  7. Date/MUIA_Date_JD
  8. Date/MUIA_Date_Language
  9. Date/MUIA_Date_MJD
  10. Date/MUIA_Date_MaxDay
  11. Date/MUIA_Date_MaxMonth
  12. Date/MUIA_Date_MaxYear
  13. Date/MUIA_Date_MinDay
  14. Date/MUIA_Date_MinMonth
  15. Date/MUIA_Date_MinYear
  16. Date/MUIA_Date_Month
  17. Date/MUIA_Date_Week
  18. Date/MUIA_Date_Weekday
  19. Date/MUIA_Date_YDay
  20. Date/MUIA_Date_Year
  21. Date/MUIM_Date_Compare
  22. Date/MUIM_Date_DecreaseDays
  23. Date/MUIM_Date_DecreaseMonths
  24. Date/MUIM_Date_DecreaseToWeekday
  25. Date/MUIM_Date_DecreaseYears
  26. Date/MUIM_Date_IncreaseDays
  27. Date/MUIM_Date_IncreaseMonths
  28. Date/MUIM_Date_IncreaseToWeekday
  29. Date/MUIM_Date_IncreaseYears
  30. Date/MUIM_Date_SetCurrent
  31. Date/--background--
  32.  
  33.    NAME
  34.     Date -- ... (V12)
  35.  
  36.    FUNCTION
  37.     Date is an abstract Custom Class of the Magic User Interface © by
  38.     Stefan Stuntz.
  39.     It's a subclass of notify-class and only usable for developers who
  40.     want to build subclasses of Date.mcc!
  41.  
  42.     The idea of this class was born during developing my Gregor
  43.     application.
  44.  
  45.     MUI abstract public custom class allowing easy handling of dates.
  46.     Because it is abstract it is only usefull for developers who are
  47.     working with classes that are based on Date.mcc (like
  48.     DateString.mcc), or who want to build their own classes based on
  49.     Date.mcc.
  50.  
  51.    NOTES
  52.     None at the moment.
  53. Date/MUIA_Date_Country
  54.  
  55.    NAME
  56.     MUIA_Date_Country, Countries [I.G] -- ... (V12)
  57.  
  58.    SYNOPSIS
  59.     MUIA_Date_Country, country,
  60.  
  61.     \*result =*\ get(obj,MUIA_Date_Country,&country);
  62.  
  63.    FUNCTION
  64.     With MUIA_Date_Country you can define the country to use
  65.     for the calendar reform.
  66.     Defaults to locale.library settings if present, else to
  67.     unknown.
  68.  
  69.    INPUTS
  70.     country - Country to use for the calendar reform
  71.        MUIV_Date_Country_Unknown
  72.        MUIV_Date_Country_Italia
  73.        MUIV_Date_Country_Deutschland
  74.        MUIV_Date_Country_Schweiz
  75.        MUIV_Date_Country_Danmark
  76.        MUIV_Date_Country_Nederland
  77.        MUIV_Date_Country_GreatBritain
  78.  
  79.    RESULT
  80.     country - Country used for the calendar reform
  81.  
  82.    NOTES
  83.     Keep in mind that this tag will overwrite the user prefs!
  84.  
  85.     At the moment this is only a dummy attribut, because country support
  86.     for the date.library is still under construction.
  87.  
  88.     Countries is defined in the date.library (Aminet:dev/c/date.lha) as
  89.     follows:
  90.     typedef enum {date_unknown,date_Italia,date_Deutschland,date_Schweiz,
  91.        date_Danmark,date_Nederland,date_GreatBritain} date_Countries;
  92.  
  93.    BUGS
  94.     No known bugs.
  95.  
  96.    SEE ALSO
  97.  
  98. Date/MUIA_Date_Day
  99.  
  100.    NAME
  101.     MUIA_Date_Day, USHORT [ISG] -- User selected day (V12)
  102.  
  103.    SYNOPSIS
  104.     MUIA_Date_Day,    1,
  105.  
  106.     \*result =*\ set(obj,MUIA_Date_Day,day);
  107.     \*result =*\ get(obj,MUIA_Date_Day,&day);
  108.  
  109.     \*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Date_Day,
  110.         MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
  111.  
  112.    FUNCTION
  113.     The MUIA_Date_Day attribute of a Date object is
  114.     triggered when a new object value is given.
  115.     Defaults to 0 if there was never a valid date value given!
  116.  
  117.    INPUTS
  118.     day - Day of the date value
  119.           Must be within the range 1-(last day of the month)
  120.  
  121.    RESULT
  122.     day - Day of the date or 0
  123.  
  124.    NOTES
  125.     Keep in mind that the day is related to MUIA_Date_Month
  126.     and MUIA_Date_Year! So it will be reset to 0 if you change
  127.     MUIA_Date_Month or MUIA_Date_Year.
  128.     If you set a wrong date or if the date is not within MinDate and
  129.     MaxDate then this attribute will be set back to its default!
  130.  
  131.    BUGS
  132.     No known bugs.
  133.  
  134.    SEE ALSO
  135.     MUIA_Date_Month, MUIA_Date_Year
  136.  
  137. Date/MUIA_Date_FirstWeekday
  138.  
  139.    NAME
  140.     MUIA_Date_FirstWeekday, Weekdays [I.G] -- ... (V12)
  141.  
  142.    SYNOPSIS
  143.     MUIA_Date_FirstWeekday, Monday,
  144.  
  145.    FUNCTION
  146.     The MUIA_Date_FirstWeekday attribute makes it possible
  147.     to define which weekday is the first weekday in the week.
  148.     Defaults to locale.library setting if present, else it defaults to
  149.     Monday.
  150.  
  151.    INPUTS
  152.     weekday - Weekday that is the first weekday of the week.
  153.        MUIV_Date_Weekday_Monday
  154.        MUIV_Date_Weekday_Tuesday
  155.        MUIV_Date_Weekday_Wednesday
  156.        MUIV_Date_Weekday_Thursday
  157.        MUIV_Date_Weekday_Friday
  158.        MUIV_Date_Weekday_Saturday
  159.        MUIV_Date_Weekday_Sunday
  160.  
  161.    NOTES
  162.     Keep in mind that this tag will overwrite the user prefs!
  163.     Weekdays is defined in the date.library (Aminet:dev/c/date.lha) as
  164.     follows:
  165.     typedef enum {date_dayerr,date_Monday,date_Tuesday,date_Wednesday,
  166.        date_Thursday,date_Friday,date_Saturday,date_Sunday}
  167.        date_Weekdays;
  168.  
  169.    BUGS
  170.     No known bugs.
  171.  
  172.    SEE ALSO
  173. Date/MUIA_Date_JD
  174.  
  175.    NAME
  176.     MUIA_Date_JD, ULONG [ISG] -- User selected JD date (V12.1)
  177.  
  178.    SYNOPSIS
  179.     MUIA_Date_JD,    2450521,
  180.  
  181.     \*result =*\ set(obj,MUIA_Date_JD,jd);
  182.     \*result =*\ get(obj,MUIA_Date_JD,&jd);
  183.  
  184.     \*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Date_JD,
  185.         MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
  186.  
  187.    FUNCTION
  188.     The MUIA_Date_JD attribute of a Date object is
  189.     triggered when a new object value is given.
  190.     Defaults to 0 if there was never a valid date value given!
  191.  
  192.    INPUTS
  193.     jd - JD date value
  194.          Must be within the range 1723980-2914672
  195.  
  196.    RESULT
  197.     jd - JD date value or 0
  198.          Don't forget to check the return value of DoMethod()!
  199.  
  200.    NOTES
  201.     Only available for 01.01.0008 - 31.12.3267, otherwise 0!
  202.     If you set a wrong date or if the date is not within MinDate and
  203.     MaxDate then this attribute will be set back to its default!
  204.  
  205.    BUGS
  206.     No known bugs.
  207.  
  208.    SEE ALSO
  209.     MUIA_Date_Day, MUIA_Date_Month, MUIA_Date_Year, MUIA_Date_MJD
  210. Date/MUIA_Date_Language
  211.  
  212.    NAME
  213.     MUIA_Date_Language, Languages [I.G] -- ... (V12)
  214.  
  215.    SYNOPSIS
  216.     MUIA_Date_Language, language,
  217.  
  218.    FUNCTION
  219.     With MUIA_Date_Language you can define the language to use
  220.     for the weekday/month names.
  221.     Defaults to locale.library settings if present, else to
  222.     ENGLISH
  223.  
  224.    INPUTS
  225.     language - Language to use for the short weekday names
  226.        MUIV_Date_Lang_Locale
  227.        MUIV_Date_Lang_English
  228.        MUIV_Date_Lang_Deutsch
  229.        MUIV_Date_Lang_Français
  230.        MUIV_Date_Lang_Español
  231.        MUIV_Date_Lang_Português
  232.        MUIV_Date_Lang_Dansk
  233.        MUIV_Date_Lang_Italiano
  234.        MUIV_Date_Lang_Nederlands
  235.        MUIV_Date_Lang_Norsk
  236.        MUIV_Date_Lang_Svenska
  237.        MUIV_Date_Lang_Polski
  238.        MUIV_Date_Lang_Suomi
  239.        MUIV_Date_Lang_Magyar
  240.        MUIV_Date_Lang_Greek
  241.        MUIV_Date_Lang_Esperanto
  242.        MUIV_Date_Lang_Latina
  243.        MUIV_Date_Lang_Russian
  244.        MUIV_Date_Lang_Czech
  245.        MUIV_Date_Lang_Catalonian
  246.  
  247.    NOTES
  248.     Keep in mind that this tag will overwrite the user prefs!
  249.     Languages is defined in the date.library (Aminet:dev/c/date.lha) as
  250.     follows:
  251.     typedef enum {date_Locale,date_ENGLISH,date_DEUTSCH,date_FRANCAIS,
  252.        date_ESPANOL,date_PORTUGUES,date_DANSK,date_ITALIANO,
  253.        date_NEDERLANDS,date_NORSK,date_SVENSKA,date_POLSKI,date_SUOMI,
  254.        date_MAGYAR,date_GREEK,date_ESPERANTO,date_TURKCE,date_LATINA,
  255.        date_RUSSIAN,plocale_CZECH,date_CATALONIAN} date_Languages;
  256.  
  257.    BUGS
  258.     No known bugs.
  259.  
  260.    SEE ALSO
  261. Date/MUIA_Date_MJD
  262.  
  263.    NAME
  264.     MUIA_Date_MJD, ULONG [ISG] -- User selected MJD date (V12.1)
  265.  
  266.    SYNOPSIS
  267.     MUIA_Date_MJD,    0,
  268.  
  269.     \*result =*\ set(obj,MUIA_Date_MJD,mjd);
  270.     \*result =*\ get(obj,MUIA_Date_MJD,&mjd);
  271.  
  272.     \*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Date_MJD,
  273.         MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
  274.  
  275.    FUNCTION
  276.     The MUIA_Date_MJD attribute of a Date object is
  277.     triggered when a new object value is given.
  278.     Defaults to 0 if there was never a valid date value given!
  279.  
  280.    INPUTS
  281.     mjd - MJD date value
  282.           Must be within the range 1-514671
  283.  
  284.    RESULT
  285.     mjd - MJD date value or 0
  286.           Don't forget to check the return value of DoMethod()!
  287.  
  288.    NOTES
  289.     Only available for 18.11.1858 - 31.12.3267, otherwise 0!
  290.     If you set a wrong date or if the date is not within MinDate and
  291.     MaxDate then this attribute will be set back to its default!
  292.  
  293.    BUGS
  294.     No known bugs.
  295.  
  296.    SEE ALSO
  297.     MUIA_Date_Day, MUIA_Date_Month, MUIA_Date_Year, MUIA_Date_JD
  298. Date/MUIA_Date_MaxDay
  299.  
  300.    NAME
  301.     MUIA_Date_MaxDay, USHORT [ISG] -- Day of the maximum date (V12.1)
  302.  
  303.    SYNOPSIS
  304.     MUIA_Date_MaxDay,    31,
  305.  
  306.     \*result =*\ set(obj,MUIA_Date_MaxDay,mday);
  307.     \*result =*\ get(obj,MUIA_Date_MaxDay,&mday);
  308.  
  309.    FUNCTION
  310.     The MUIA_Date_MaxDay attribute of a Date object is
  311.     the day of the maximum date that can be set.
  312.     Defaults to 31.
  313.  
  314.    RESULT
  315.     mday - Day of the maximum date
  316.  
  317.    NOTES
  318.     Keep in mind that the day is related to MUIA_Date_MaxMonth
  319.     and MUIA_Date_MaxYear!
  320.     If you set a wrong date or if MinDate is >= MaxDate then this
  321.     attribute will be set back to its default!
  322.  
  323.    BUGS
  324.     No known bugs.
  325.  
  326.    SEE ALSO
  327.     MUIA_Date_MaxMonth, MUIA_Date_MaxYear
  328. Date/MUIA_Date_MaxMonth
  329.  
  330.    NAME
  331.     MUIA_Date_MaxMonth, USHORT [ISG] -- Month of max. date (V12.1)
  332.  
  333.    SYNOPSIS
  334.     MUIA_Date_MaxMonth, 1,
  335.  
  336.     \*result =*\ set(obj,MUIA_Date_MaxMonth,mmonth);
  337.     \*result =*\ get(obj,MUIA_Date_MaxMonth,&mmonth);
  338.  
  339.    FUNCTION
  340.     The MUIA_Date_MaxMonth attribute of a Date object is
  341.     the month of the maximum date that can be set.
  342.     Defaults to 12.
  343.  
  344.    INPUTS
  345.     mmonth - Month of the maximum date
  346.  
  347.    RESULT
  348.     mmonth - Month of the maximum date
  349.  
  350.    NOTES
  351.     Keep in mind that the month is related to MUIA_Date_MaxYear!
  352.     If you set a wrong date or if MinDate is >= MaxDate then this
  353.     attribute will be set back to its default!
  354.  
  355.    BUGS
  356.     No known bugs.
  357.  
  358.    SEE ALSO
  359.     MUIA_Date_MaxDay, MUIA_Date_MaxYear
  360. Date/MUIA_Date_MaxYear
  361.  
  362.    NAME
  363.     MUIA_Date_MaxYear, int [ISG] -- Year of the max. date (V12.1)
  364.  
  365.    SYNOPSIS
  366.     MUIA_Date_MaxYear, 2077,
  367.  
  368.     \*result =*\ set(obj,MUIA_Date_MaxYear,myear);
  369.     \*result =*\ get(obj,MUIA_Date_MaxYear,&myear);
  370.  
  371.    FUNCTION
  372.     The MUIA_Date_MaxYear attribute of a Date object is
  373.     the year of the maximum date that can be set.
  374.     Defaults to 8000.
  375.  
  376.    INPUTS
  377.     myear - Year of the maximum date
  378.  
  379.    RESULT
  380.     myear - Year of the maximum date
  381.  
  382.    NOTES
  383.     Always use full year numbers! I.e. use 1996 and *NOT* 96
  384.     If you set a wrong date or if MinDate is >= MaxDate then this
  385.     attribute will be set back to its default!
  386.  
  387.    BUGS
  388.     No known bugs.
  389.  
  390.    SEE ALSO
  391.     MUIA_Date_MaxDay, MUIA_Date_MaxMonth
  392. Date/MUIA_Date_MinDay
  393.  
  394.    NAME
  395.     MUIA_Date_MinDay, USHORT [ISG] -- Day of the minimum date (V12.1)
  396.  
  397.    SYNOPSIS
  398.     MUIA_Date_MinDay,    1,
  399.  
  400.     \*result =*\ set(obj,MUIA_Date_MinDay,mday);
  401.     \*result =*\ get(obj,MUIA_Date_MinDay,&mday);
  402.  
  403.    FUNCTION
  404.     The MUIA_Date_MinDay attribute of a Date object is
  405.     the day of the minimum date that can be set.
  406.     Defaults to 1.
  407.  
  408.    RESULT
  409.     mday - Day of the minimum date
  410.  
  411.    NOTES
  412.     Keep in mind that the day is related to MUIA_Date_MinMonth
  413.     and MUIA_Date_MinYear!
  414.     If you set a wrong date or if MinDate is >= MaxDate then this
  415.     attribute will be set back to its default!
  416.  
  417.    BUGS
  418.     No known bugs.
  419.  
  420.    SEE ALSO
  421.     MUIA_Date_MinMonth, MUIA_Date_MinYear
  422.  
  423. Date/MUIA_Date_MinMonth
  424.  
  425.    NAME
  426.     MUIA_Date_MinMonth, USHORT [ISG] -- Month of min. date (V12.1)
  427.  
  428.    SYNOPSIS
  429.     MUIA_Date_MinMonth, 1,
  430.  
  431.     \*result =*\ set(obj,MUIA_Date_MinMonth,mmonth);
  432.     \*result =*\ get(obj,MUIA_Date_MinMonth,&mmonth);
  433.  
  434.    FUNCTION
  435.     The MUIA_Date_MinMonth attribute of a Date object is
  436.     the month of the minimum date that can be set.
  437.     Defaults to 1.
  438.  
  439.    INPUTS
  440.     mmonth - Month of the minimum date
  441.  
  442.    RESULT
  443.     mmonth - Month of the minimum date
  444.  
  445.    NOTES
  446.     Keep in mind that the month is related to MUIA_Date_MinYear!
  447.     If you set a wrong date or if MinDate is >= MaxDate then this
  448.     attribute will be set back to its default!
  449.  
  450.    BUGS
  451.     No known bugs.
  452.  
  453.    SEE ALSO
  454.     MUIA_Date_MinDay, MUIA_Date_MinYear
  455. Date/MUIA_Date_MinYear
  456.  
  457.    NAME
  458.     MUIA_Date_MinYear, int [ISG] -- Year of the min. date (V12.1)
  459.  
  460.    SYNOPSIS
  461.     MUIA_Date_MinYear, 1978,
  462.  
  463.     \*result =*\ set(obj,MUIA_Date_MinYear,myear);
  464.     \*result =*\ get(obj,MUIA_Date_MinYear,&myear);
  465.  
  466.    FUNCTION
  467.     The MUIA_Date_MinYear attribute of a Date object is
  468.     the year of the minimum date that can be set.
  469.     Defaults to 8.
  470.  
  471.    INPUTS
  472.     myear - Year of the minimum date
  473.  
  474.    RESULT
  475.     myear - Year of the minimum date
  476.  
  477.    NOTES
  478.     Always use full year numbers! I.e. use 1996 and *NOT* 96
  479.     If you set a wrong date or if MinDate is >= MaxDate then this
  480.     attribute will be set back to its default!
  481.  
  482.    BUGS
  483.     No known bugs.
  484.  
  485.    SEE ALSO
  486.     MUIA_Date_MinDay, MUIA_Date_MinMonth
  487. Date/MUIA_Date_Month
  488.  
  489.    NAME
  490.     MUIA_Date_Month, USHORT [ISG] -- Used month (V12)
  491.  
  492.    SYNOPSIS
  493.     MUIA_Date_Month, 1,
  494.  
  495.     \*result =*\ set(obj,MUIA_Date_Month,month);
  496.     \*result =*\ get(obj,MUIA_Date_Month,&month);
  497.  
  498.     \*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Date_Month,
  499.         MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
  500.  
  501.    FUNCTION
  502.     The MUIA_Date_Month attribute of a Date object is
  503.     triggered when a new object value is given.
  504.     Defaults to 0 if there was never a valid date value given!
  505.  
  506.    INPUTS
  507.     month - Month of the date value
  508.             Must be within the range 1-12
  509.  
  510.    RESULT
  511.     month - Month of the date value or 0
  512.  
  513.    NOTES
  514.     Keep in mind that the month is related to MUIA_Date_Year!
  515.     If you set a wrong date or if the date is not within MinDate and
  516.     MaxDate then this attribute will be set back to its default!
  517.  
  518.    BUGS
  519.     No known bugs.
  520.  
  521.    SEE ALSO
  522.     MUIA_Date_Year, MUIA_Date_Day
  523. Date/MUIA_Date_Week
  524.  
  525.    NAME
  526.     MUIA_Date_Week, USHORT [..G] -- Week within the year (V12.1)
  527.  
  528.    SYNOPSIS
  529.     \*result =*\ get(obj,MUIA_Date_Week,&week);
  530.  
  531.     \*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Date_Week,
  532.         MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
  533.  
  534.    FUNCTION
  535.     The MUIA_Date_Week attribute of a Date object is the week of the date
  536.     within the year.
  537.     Defaults to 0 if there was never a valid date value given!
  538.  
  539.    RESULT
  540.     week - Week of the date within the year (1-53)
  541.  
  542.    NOTES
  543.     Keep in mind, that the week of the first days within a year might
  544.     be 52/53, because then these days are part of the old years week!
  545.  
  546.    BUGS
  547.     No known bugs.
  548.  
  549.    SEE ALSO
  550.     MUIA_Date_Weekday, MUIA_Date_FirstWeekday
  551. Date/MUIA_Date_Weekday
  552.  
  553.    NAME
  554.     MUIA_Date_Weekday, USHORT [..G] -- Weekday of the date (V12.1)
  555.  
  556.    SYNOPSIS
  557.     \*result =*\ get(obj,MUIA_Date_Weekday,&wd);
  558.  
  559.     \*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Date_Weekday,
  560.         MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
  561.  
  562.    FUNCTION
  563.     The MUIA_Date_Weekday attribute of a Date object is the weekday
  564.     (Monday-Sunday) of the date.
  565.     Defaults to 0 if there was never a valid date value given!
  566.  
  567.    RESULT
  568.     wd - Weekday of the date (Monday-Sunday)
  569.         MUIV_Date_Weekday_Monday
  570.         MUIV_Date_Weekday_Tuesday
  571.         MUIV_Date_Weekday_Wednesday
  572.         MUIV_Date_Weekday_Thursday
  573.         MUIV_Date_Weekday_Friday
  574.         MUIV_Date_Weekday_Saturday
  575.         MUIV_Date_Weekday_Sunday
  576.  
  577.    NOTES
  578.     None
  579.  
  580.    BUGS
  581.     No known bugs.
  582.  
  583.    SEE ALSO
  584.     MUIA_Date_FirstWeekday, MUIA_Date_Week
  585. Date/MUIA_Date_YDay
  586.  
  587.    NAME
  588.     MUIA_Date_YDay, USHORT [..G] -- Day within the year (V12.1)
  589.  
  590.    SYNOPSIS
  591.     \*result =*\ get(obj,MUIA_Date_YDay,&yday);
  592.  
  593.     \*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Date_YDay,
  594.         MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
  595.  
  596.    FUNCTION
  597.     The MUIA_Date_YDay attribute of a Date object is the day (1-366)
  598.     of the date within the year.
  599.     Defaults to 0 if there was never a valid date value given!
  600.  
  601.    RESULT
  602.     yday - Day of the year (1-366)
  603.  
  604.    NOTES
  605.     Keep in mind that the yday is related to MUIA_Date_Year! So it will
  606.     be reset to 0 if you change MUIA_Date_Year.
  607.     If you set a wrong date or if the date is not within MinDate and
  608.     MaxDate then this attribute will be set back to its default!
  609.  
  610.    BUGS
  611.     No known bugs.
  612.  
  613.    SEE ALSO
  614.     MUIA_Date_Year
  615. Date/MUIA_Date_Year
  616.  
  617.    NAME
  618.     MUIA_Date_Year, LONG [ISG] -- Used year (V12)
  619.  
  620.    SYNOPSIS
  621.     MUIA_Date_Year, 1997,
  622.  
  623.     \*result =*\ set(obj,MUIA_Date_Year,year);
  624.     \*result =*\ get(obj,MUIA_Date_Year,&year);
  625.  
  626.     \*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Date_Year,
  627.         MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
  628.  
  629.    FUNCTION
  630.     The MUIA_Date_Year attribute of a Date object is
  631.     triggered when a new object value is given.
  632.     Defaults to 0 if there was never a valid date value given!
  633.  
  634.    INPUTS
  635.     year - Year of the date value
  636.            Must be within the range 8-8000
  637.  
  638.    RESULT
  639.     year - Year of the date value or 0
  640.  
  641.    NOTES
  642.     Always use full year numbers! I.e. use 1996 and *NOT* 96.
  643.     If you set a wrong date or if the date is not within MinDate and
  644.     MaxDate then this attribute will be set back to its default!
  645.  
  646.    BUGS
  647.     No known bugs.
  648.  
  649.    SEE ALSO
  650.     MUIA_Date_Month, MUIA_Date_Day
  651. Date/MUIM_Date_Compare
  652.  
  653.    NAME
  654.     MUIM_Date_Compare -- Compare with another date object (V12.1)
  655.  
  656.    SYNOPSIS
  657.     result = (LONG)DoMethod(obj,MUIM_Date_Compare,dobj);
  658.  
  659.    FUNCTION
  660.     Compares the date object with another date object.
  661.  
  662.    RESULT
  663.     result - -1 : obj < dobj : MUIV_Date_Compare_Less
  664.           0 : obj = dobj : MUIV_Date_Compare_Equal
  665.           1 : obj > dobj : MUIV_Date_Compare_Greater
  666.  
  667.    NOTES
  668.     The result is undefined when dobj is not a Date object!
  669.  
  670.    BUGS
  671.     No known bugs.
  672.  
  673.    SEE ALSO
  674.  
  675. Date/MUIM_Date_DecreaseDays
  676.  
  677.    NAME
  678.     MUIM_Date_DecreaseDays -- Decrease the date by days (V12)
  679.  
  680.    SYNOPSIS
  681.     \*result =*\ DoMethod(obj,MUIM_Date_DecreaseDays,days);
  682.  
  683.    FUNCTION
  684.     Decreases the date by days.
  685.  
  686.    INPUTS
  687.     days - Days to subtract from the date.
  688.  
  689.    NOTES
  690.     MUIM_Date_DecreaseDays considers the Min- and MaxDate settings.
  691.  
  692.    BUGS
  693.     No known bugs.
  694.  
  695.    SEE ALSO
  696.     MUIM_Date_IncreaseDays, MUIM_Date_DecreaseMonths,
  697.     MUIM_Date_DecreaseYears, MUIM_Date_DecreaseToWeekday
  698. Date/MUIM_Date_DecreaseMonths
  699.  
  700.    NAME
  701.     MUIM_Date_DecreaseMonths -- Decrease the date by months (V12)
  702.  
  703.    SYNOPSIS
  704.     \*result =*\ DoMethod(obj,MUIM_Date_DecreaseMonths,months);
  705.  
  706.    FUNCTION
  707.     Decreases the date by months.
  708.  
  709.    INPUTS
  710.     months - Months to subtract from the date.
  711.  
  712.    NOTES
  713.     MUIM_Date_DecreaseMonths considers the Min- and MaxDate settings.
  714.  
  715.    BUGS
  716.     No known bugs.
  717.  
  718.    SEE ALSO
  719.     MUIM_Date_IncreaseMonths, MUIM_Date_DecreaseDays,
  720.     MUIM_Date_DecreaseYears, MUIM_Date_DecreaseToWeekday
  721. Date/MUIM_Date_DecreaseToWeekday
  722.  
  723.    NAME
  724.     MUIM_Date_DecreaseToWeekday -- Dec. the date downto a weekday (V12)
  725.  
  726.    SYNOPSIS
  727.     \*result =*\ DoMethod(obj,MUIM_Date_DecreaseToWeekday,weekday);
  728.  
  729.    FUNCTION
  730.     Decreases the date downto a weekday.
  731.  
  732.    INPUTS
  733.     weekday - Weekday to decrease to from the actual date.
  734.  
  735.    NOTES
  736.     MUIM_Date_DecreaseToWeekday considers the Min- and MaxDate settings.
  737.  
  738.    BUGS
  739.     No known bugs.
  740.  
  741.    SEE ALSO
  742.     MUIM_Date_IncreaseToWeekday, MUIM_Date_DecreaseDays,
  743.     MUIM_Date_DecreaseMonths, MUIM_Date_DecreaseYears
  744. Date/MUIM_Date_DecreaseYears
  745.  
  746.    NAME
  747.     MUIM_Date_DecreaseYears -- Decrease the date by years (V12)
  748.  
  749.    SYNOPSIS
  750.     \*result =*\ DoMethod(obj,MUIM_Date_DecreaseYears,years);
  751.  
  752.    FUNCTION
  753.     Decreases the date by years.
  754.  
  755.    INPUTS
  756.     years - Years to subtract from the date.
  757.  
  758.    NOTES
  759.     MUIM_Date_DecreaseYears considers the Min- and MaxDate settings.
  760.  
  761.    BUGS
  762.     No known bugs.
  763.  
  764.    SEE ALSO
  765.     MUIM_Date_IncreaseYears, MUIM_Date_DecreaseDays,
  766.     MUIM_Date_DecreaseMonths, MUIM_Date_DecreaseToWeekday
  767. Date/MUIM_Date_IncreaseDays
  768.  
  769.    NAME
  770.     MUIM_Date_IncreaseDays -- Increase the date by days (V12)
  771.  
  772.    SYNOPSIS
  773.     \*result =*\ DoMethod(obj,MUIM_Date_IncreaseDays,days);
  774.  
  775.    FUNCTION
  776.     Increases the date by days.
  777.  
  778.    INPUTS
  779.     days - Days to add to the date.
  780.  
  781.    NOTES
  782.     MUIM_Date_IncreaseDays considers the Min- and MaxDate settings.
  783.  
  784.    BUGS
  785.     No known bugs.
  786.  
  787.    SEE ALSO
  788.     MUIM_Date_DecreaseDays, MUIM_Date_IncreaseMonths,
  789.     MUIM_Date_IncreaseYears, MUIM_Date_IncreaseToWeekday
  790. Date/MUIM_Date_IncreaseMonths
  791.  
  792.    NAME
  793.     MUIM_Date_IncreaseMonths -- Increase the date by months (V12)
  794.  
  795.    SYNOPSIS
  796.     \*result =*\ DoMethod(obj,MUIM_Date_IncreaseMonths,months);
  797.  
  798.    FUNCTION
  799.     Increases the date by months.
  800.  
  801.    INPUTS
  802.     months - Months to add to the date.
  803.  
  804.    NOTES
  805.     MUIM_Date_IncreaseMonths considers the Min- and MaxDate settings.
  806.  
  807.    BUGS
  808.     No known bugs.
  809.  
  810.    SEE ALSO
  811.     MUIM_Date_DecreaseMonths, MUIM_Date_IncreaseDays,
  812.     MUIM_Date_IncreaseYears, MUIM_Date_IncreaseToWeekday
  813. Date/MUIM_Date_IncreaseToWeekday
  814.  
  815.    NAME
  816.     MUIM_Date_IncreaseToWeekday -- Increase the date upto a weekday (V12)
  817.  
  818.    SYNOPSIS
  819.     \*result =*\ DoMethod(obj,MUIM_Date_IncreaseToWeekday,weekday);
  820.  
  821.    FUNCTION
  822.     Increases the date upto a weekday.
  823.  
  824.    INPUTS
  825.     weekday - Weekday to increase to from the actual date.
  826.  
  827.    NOTES
  828.     MUIM_Date_IncreaseToWeekday considers the Min- and MaxDate settings.
  829.  
  830.    BUGS
  831.     No known bugs.
  832.  
  833.    SEE ALSO
  834.     MUIM_Date_DecreaseToWeekday, MUIM_Date_IncreaseDays,
  835.     MUIM_Date_IncreaseMonths, MUIM_Date_IncreaseYears
  836. Date/MUIM_Date_IncreaseYears
  837.  
  838.    NAME
  839.     MUIM_Date_IncreaseYears -- Increase the date by years (V12)
  840.  
  841.    SYNOPSIS
  842.     \*result =*\ DoMethod(obj,MUIM_Date_IncreaseYears,years);
  843.  
  844.    FUNCTION
  845.     Increases the date by years.
  846.  
  847.    INPUTS
  848.     years - Years to add to the date.
  849.  
  850.    NOTES
  851.     MUIM_Date_IncreaseYears considers the Min- and MaxDate settings.
  852.  
  853.    BUGS
  854.     No known bugs.
  855.  
  856.    SEE ALSO
  857.     MUIM_Date_DecreaseYears, MUIM_Date_IncreaseDays,
  858.     MUIM_Date_IncreaseMonths, MUIM_Date_IncreaseToWeekday
  859. Date/MUIM_Date_SetCurrent
  860.  
  861.    NAME
  862.     MUIM_Date_SetCurrent -- Set the current date (V12)
  863.  
  864.    SYNOPSIS
  865.     \*result =*\ DoMethod(obj,MUIM_Date_SetCurrent);
  866.  
  867.    FUNCTION
  868.     Set the current date.
  869.  
  870.    NOTES
  871.     The date will be set to 0 when the current date is invalid.
  872.     When the current date exceeds the min or max limit, it will be
  873.     set to the belonging limit.
  874.  
  875.    BUGS
  876.     No known bugs.
  877.  
  878.    SEE ALSO
  879.